dxp-ux

(0 reviews)

TMF621 GET - Query Case Details in SF

Query Case Details in Salesforce.

URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/troubleTicket
Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, HN, CR, DO etc..) identifying the business unit.
Expected one is "PR"-Puerto Rico
Y
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.Y

Query Param

NameTypeDescriptionrequired
relatedEntity.rolestringThe role of an entity. i.e accountNumber, salesforceAccountId, msisdn, orderIdY
relatedEntity.idstringUnique identifier of a related entity.Y
creationDate.gtdate-timeStart of Case Created DateN
creationDate.ltdate-timeEnd of Case Created DateN
ticketTypestringCase type. For this use case "Port In"N
channel.idstringChannel/Source IdentifierY
statusstringStatus filter (New, In Progress,Closed, etc.)N
limitstringPage size. Default: 50N
offsetstringPagination offset. Default: 0N

Note: At least one identifier must be provided: accountNumber, salesforceAccountId, or msisdn

cURL Request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/troubleTicket?relatedEntity.id=BAN-920001&relatedEntity.role=accountNumber&relatedEntity.id=001dm00000ACC001&relatedEntity.role=salesforceAccountId&relatedEntity.id=7875551234&relatedEntity.role=msisdn&relatedEntity.id=er4567gh788&relatedEntity.role=orderId&creationDate.gt=2026-01-01T00%3A00%3A00Z&creationDate.lt=2026-02-01T00%3A00%3A00Z&ticketType=Port%20In&channel.id=Digital&limit=50&offset=0&status=New%2CInProgress%2CCompleted' \
--header 'client_id: 12344' \
--header 'client_secret: 11111' \
--header 'X-Correlation-ID: {guid}'
Response
[
    {
        "id": "00012345",
        "externalId": "500dm00000A1B2C",
        "description": "Customer reported slow data speeds on primary line",
        "status": "inProgress",
        "priority": "High",
        "name": "Network",
        "ticketType": "B2C Technical Support",
        "creationDate": "2026-01-19T10:32:11.000Z",
        "lastUpdate": "2026-01-20T08:15:40.000Z",
        "relatedParty": [
            {
                "id": "001dm00000ACC001",
                "role": "customer",
                "name": "John Doe",
                "@referredType": "Customer"
            }
        ],
        "relatedEntity": [
            {
                "id": "001dm00000ACC001",
                "role": "providerAccountNumber",
                "@referredType": "Provider"
            },
            {
                "id": "801dm00000ORD002",
                "role": "order",
                "@referredType": "Customer"
            },
            {
                "id": "BAN-920001",

                "role": "accoutNumber",
                "@referredType": "Customer"
            }
        ],
        "troubleTicketCharacteristic": [
            {
                "name": "zipCode",
                "value": "00908"
            },
            {
                "name": "portingPin",
                "value": "11111"
            },
            {
                "name": "totalCount",
                "value": "2"
            }
        ]
    }
]
Definitions

Each of the response parameters is detailed.

nametypedescriptionrequired
idstringCase NumberY
externalIdstringSalesforce Case IdY
descriptionstringCase descriptionN
statusstringCase statusY
prioritystringPriority valueN
namestringCase category/typeN
ticketTypestringTrouble ticket typeN
creationDatedate-timeCreatedDate (ISO-8601)Y
lastUpdatedate-timeLastModifiedDateY
realtedPartyarrayThe related party(ies) that are associated to the ticketN
realtedParty.idstringSalesforce IdN
realtedParty.rolestringRole of the related partyN
realtedParty.namestringDisplay nameN
realtedParty.@referredTypestringThe actual type of the target instance when needed for disambiguationN
relatedEntityarrayAn entity that is related to the ticketN
relatedEntity.idstringUnique identifier of a related entityN
relatedEntity.rolestringThe role of an entity.N
relatedEntity.@referredTypestringThe actual type of the target instance when needed for disambiguationN
troubleTicketCharacteristicarrayTrouble ticket characteristicN
troubleTicketCharacteristic.namestringName of the characteristicN
troubleTicketCharacteristic.valuestringValue of the characteristicN

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}
[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}
[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}
[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method DELETE not allowed for : /{businessId}/topupbalance"
        }]
}
[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error"
    }]
}
[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /topupbalance for Business Id: xxxx not implemented"
    }]
  }

Reviews